DescribeEntityList

Description

No description for this api.

Request Method

POST

Request Path

/apsara/route/Sas/DescribeEntityList

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
Status	BODY	string	No	No sample value for this parameter.	Server Guard Agent status. Value: offiline: offline pause: Pause protection status
RegionNo	BODY	string	No	No sample value for this parameter.	area number.
Account	BODY	string	No	No sample value for this parameter.	filter host instances with abnormal login events. Value: remoteLogin
PageSize	BODY	integer	No	No sample value for this parameter.	specifies the maximum number of records per page in the returned result. default value: 20
OS	BODY	string	No	No sample value for this parameter.	host operating system type, value range: win: indicates Windows type of operating system linux: indicates Linux type operating system
Health	BODY	string	No	No sample value for this parameter.	filter host instances with baseline check problems. Value: exception
TagIdList	BODY	string	No	No sample value for this parameter.	host asset tag ID.
version	BODY	string	No	2016-01-01	version of api
GroupId	BODY	long	No	No sample value for this parameter.	asset group ID.
CurrentPage	BODY	integer	No	No sample value for this parameter.	specifies the number of pages currently returned. default value: 1
Suspicious	BODY	string	No	No sample value for this parameter.	filter host instances with abnormal events. Value: exception
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Trojan	BODY	string	No	No sample value for this parameter.	filter host instances with backdoor files. Value: webshell: indicates a website trojan file process: indicates Trojan process
Patch	BODY	string	No	No sample value for this parameter.	filter vulnerable host instances. Value: vul

Return data

Name	Type	Sample value	Description
ClientStatus	boolean	no demo value	whether the host instance is protected or not, whether it returns or not indicates that the host is pausing protection.
AegisVersion	string	no demo value	Server Guard Agent version.
BuyVersion	string	no demo value	Server Knight package version.
RequestId	string	no demo value	request ID.
PageSize	integer	no demo value	page displays the maximum number of records.
OS	string	no demo value	operating system type.
Ip	string	no demo value	host asset IP. description gives priority to the public IP of the host. if the host does not have a public IP, the private IP is displayed.
EntityList	array	no demo value	host instance list information, see the following parameter description for specific sub-items.
AegisOnline	boolean	no demo value	Whether the Server Guard Agent is online.
Flag	integer	no demo value	Host ID: 0: indicates Alibaba Cloud ECS instance 1: indicates non-Alibaba Cloud host
GroupId	integer	no demo value	asset group ID.
InstanceName	string	no demo value	host instance name.
TotalCount	integer	no demo value	returns the total number of records.
Uuid	string	no demo value	host asset UUID.
CurrentPage	integer	no demo value	currently returns page number.
name	type	no demo value	Description
Region	string	no demo value	area code.

Example

Successful Response example

{
 "ClientStatus":"no demo value",
 "AegisVersion":"no demo value",
 "BuyVersion":"no demo value",
 "RequestId":"no demo value",
 "PageSize":"no demo value",
 "OS":"no demo value",
 "Ip":"no demo value",
 "EntityList":"no demo value",
 "AegisOnline":"no demo value",
 "Flag":"no demo value",
 "GroupId":"no demo value",
 "InstanceName":"no demo value",
 "TotalCount":"no demo value",
 "Uuid":"no demo value",
 "CurrentPage":"no demo value",
 "name":"no demo value",
 "Region":"no demo value"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}